package chapter.seventh.item44;

import java.util.List;

/**
 * 文档注释示例类
 * @author lzy
 * @since 1.0
 *
 */
public class DocuemntDemo {
	
	/**
	 * 返回检查结果的描述，该方法检查是否开始值小于结束值，描述方式如下：
	 * <pre>{@code
	 * 	if(!(start<=end)) {
	 * 		throw new IllegalArgumentException();
	 * 	}
	 * }</pre>
	 * 这也可以通过{@link Math#max(int,int)}比较后返回结果描述.
	 *
	 * @param start 起始整数
	 * @param end  结尾整数
	 * @return 一个字符串，表示检查结果
	 * @throws IllegalArgumentException 如果不满足条件<tt>start <= end</tt>
	 */
	public String check(int start,int end) throws IllegalArgumentException{
		if(!(start<=end))
			throw new IllegalArgumentException("start > end");
		return "检查结果";
	}

	/**
	 * {@inheritDoc}
	 * <a href="{@docRoot}/../technotes/guides/collections/index.html">
	 * Java Collections Framework</a>
	 * @return 一个代表DocumentDemo类型对象的字符串
	 */
	@Override
	public String toString() {
		return super.toString();
	}
	
	/**
	 * {@inheritDoc}
	 */
	public boolean equals(Object obj){
		return true;
	}
	
	
}
